<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xilocp: XilOcp API IDs</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xilocp
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__xocp__api__ids.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#enumval-members">Enumerator</a>  </div>
  <div class="headertitle">
<div class="title">XilOcp API IDs</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gaacfcb856e34e9be4766a8d0498ad832f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xocp__api__ids.html#gaacfcb856e34e9be4766a8d0498ad832f">XOcp_DCacheFlushRange</a>(SrcAddr, Len)&#160;&#160;&#160;Xil_DCacheFlushRange((INTPTR)SrcAddr, Len)</td></tr>
<tr class="memdesc:gaacfcb856e34e9be4766a8d0498ad832f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cache Invalidate function.  <a href="#gaacfcb856e34e9be4766a8d0498ad832f">More...</a><br/></td></tr>
<tr class="separator:gaacfcb856e34e9be4766a8d0498ad832f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga41127f0b373baf2090c38aaecfe71f0b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xocp__api__ids.html#ga41127f0b373baf2090c38aaecfe71f0b">XOCP_API</a>(ApiId)&#160;&#160;&#160;((u32)ApiId)</td></tr>
<tr class="memdesc:ga41127f0b373baf2090c38aaecfe71f0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Macro to typecast XOCP API ID.  <a href="#ga41127f0b373baf2090c38aaecfe71f0b">More...</a><br/></td></tr>
<tr class="separator:ga41127f0b373baf2090c38aaecfe71f0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5b1f076af518588d82d3c1292274a1d9"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xocp__api__ids.html#ga5b1f076af518588d82d3c1292274a1d9">XOCP_API_ID_MASK</a>&#160;&#160;&#160;0xFFU</td></tr>
<tr class="memdesc:ga5b1f076af518588d82d3c1292274a1d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mask for API ID in Secure IPI command.  <a href="#ga5b1f076af518588d82d3c1292274a1d9">More...</a><br/></td></tr>
<tr class="separator:ga5b1f076af518588d82d3c1292274a1d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7365d3fa2793edeb5a50ca16d130f019"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xocp__api__ids.html#ga7365d3fa2793edeb5a50ca16d130f019">XOCP_EXTENDED_HASH_SIZE_IN_BYTES</a>&#160;&#160;&#160;(48U)</td></tr>
<tr class="memdesc:ga7365d3fa2793edeb5a50ca16d130f019"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extended hash buffer size in bytes.  <a href="#ga7365d3fa2793edeb5a50ca16d130f019">More...</a><br/></td></tr>
<tr class="separator:ga7365d3fa2793edeb5a50ca16d130f019"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa8d58e56f5d115e19424d4d0d02b8207"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xocp__api__ids.html#gaa8d58e56f5d115e19424d4d0d02b8207">XOCP_EXTENDED_HASH_SIZE_IN_BITS</a>&#160;&#160;&#160;(384U)</td></tr>
<tr class="memdesc:gaa8d58e56f5d115e19424d4d0d02b8207"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extended hash buffer size in bits.  <a href="#gaa8d58e56f5d115e19424d4d0d02b8207">More...</a><br/></td></tr>
<tr class="separator:gaa8d58e56f5d115e19424d4d0d02b8207"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab835a3422a1a25e56cea83a48d48560e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xocp__api__ids.html#gab835a3422a1a25e56cea83a48d48560e">XOCP_DME_NONCE_SIZE_IN_BITS</a>&#160;&#160;&#160;(256U)</td></tr>
<tr class="memdesc:gab835a3422a1a25e56cea83a48d48560e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Nonce buffer size in bits.  <a href="#gab835a3422a1a25e56cea83a48d48560e">More...</a><br/></td></tr>
<tr class="separator:gab835a3422a1a25e56cea83a48d48560e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4870addc7ba09c6a7cfdbb443f3e340d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xocp__api__ids.html#ga4870addc7ba09c6a7cfdbb443f3e340d">XOCP_ADDR_HIGH_SHIFT</a>&#160;&#160;&#160;(32U)</td></tr>
<tr class="memdesc:ga4870addc7ba09c6a7cfdbb443f3e340d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shift to get higher address.  <a href="#ga4870addc7ba09c6a7cfdbb443f3e340d">More...</a><br/></td></tr>
<tr class="separator:ga4870addc7ba09c6a7cfdbb443f3e340d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
XOcp API ids</h2></td></tr>
<tr class="memitem:gae95d465df2996596afe4dd4e5f669667"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xocp__api__ids.html#gae95d465df2996596afe4dd4e5f669667">XOcp_ApiId</a> { <br/>
&#160;&#160;<a class="el" href="group__xocp__api__ids.html#ggae95d465df2996596afe4dd4e5f669667a284a6e25cd4cd8ecd456b731f3ef8c94">XOCP_API_FEATURES</a> = 0U,
<a class="el" href="group__xocp__api__ids.html#ggae95d465df2996596afe4dd4e5f669667a0ea33ccca2247ae86b23182b1d691e25">XOCP_API_EXTEND_HWPCR</a>,
<a class="el" href="group__xocp__api__ids.html#ggae95d465df2996596afe4dd4e5f669667a0165a00496c3a9724f9e97be4262fef6">XOCP_API_GET_HWPCR</a>,
<a class="el" href="group__xocp__api__ids.html#ggae95d465df2996596afe4dd4e5f669667a04912d871713dcd3b61d694f429bc095">XOCP_API_GET_HWPCRLOG</a>,
<br/>
&#160;&#160;<a class="el" href="group__xocp__api__ids.html#ggae95d465df2996596afe4dd4e5f669667ac30d0d7181e066b8a984ede325504cf8">XOCP_API_GENDMERESP</a>,
<a class="el" href="group__xocp__api__ids.html#ggae95d465df2996596afe4dd4e5f669667a7af3c34b216fdfca90d0d831514044a0">XOCP_API_DEVAKINPUT</a>,
<a class="el" href="group__xocp__api__ids.html#ggae95d465df2996596afe4dd4e5f669667a928aad79a711aa80ab131b85ca6951e5">XOCP_API_GETCERTUSERCFG</a>,
<a class="el" href="group__xocp__api__ids.html#ggae95d465df2996596afe4dd4e5f669667a27d6f0ea57a51b0b5cb4b61f85c690a8">XOCP_API_GETX509CERT</a>,
<br/>
&#160;&#160;<a class="el" href="group__xocp__api__ids.html#ggae95d465df2996596afe4dd4e5f669667a82068a5409464a0f6dc3dcc23037d747">XOCP_API_ATTESTWITHDEVAK</a>,
<a class="el" href="group__xocp__api__ids.html#ggae95d465df2996596afe4dd4e5f669667a0849254c181626b2ccc0bca601313933">XOCP_API_SET_SWPCRCONFIG</a>,
<a class="el" href="group__xocp__api__ids.html#ggae95d465df2996596afe4dd4e5f669667a802d68e4fc35a8bb08e4e79fd2a5aa48">XOCP_API_EXTEND_SWPCR</a>,
<a class="el" href="group__xocp__api__ids.html#ggae95d465df2996596afe4dd4e5f669667a0d48b20c276c35c9e253b2756aa9f1ac">XOCP_API_GET_SWPCR</a>,
<br/>
&#160;&#160;<a class="el" href="group__xocp__api__ids.html#ggae95d465df2996596afe4dd4e5f669667a4e737b47477267f9e7b792a237c388d0">XOCP_API_GET_SWPCRLOG</a>,
<a class="el" href="group__xocp__api__ids.html#ggae95d465df2996596afe4dd4e5f669667a6ad39f4af276b8893ca0e8975a6f8f6f">XOCP_API_GET_SWPCRDATA</a>,
<a class="el" href="group__xocp__api__ids.html#ggae95d465df2996596afe4dd4e5f669667a159154b25019671afd2acc943f5ee6e2">XOCP_API_GEN_SHARED_SECRET</a>,
<a class="el" href="group__xocp__api__ids.html#ggae95d465df2996596afe4dd4e5f669667a3ee212594f10d93c996947ac021ac2ef">XOCP_API_ATTEST_WITH_KEYWRAP_DEVAK</a>,
<br/>
&#160;&#160;<a class="el" href="group__xocp__api__ids.html#ggae95d465df2996596afe4dd4e5f669667a3bc966370e0b71c627e2f312f0c3089e">XOCP_API_MAX</a>
<br/>
 }</td></tr>
<tr class="separator:gae95d465df2996596afe4dd4e5f669667"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga4870addc7ba09c6a7cfdbb443f3e340d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOCP_ADDR_HIGH_SHIFT&#160;&#160;&#160;(32U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Shift to get higher address. </p>

<p>Referenced by <a class="el" href="group__xocp__client__apis.html#ga43e275e75f776f74a124968aa83d29a2">XOcp_ClientAttestWithKeyWrapDevAk()</a>, and <a class="el" href="group__xocp__client__apis.html#ga50bd2fa853d6aba7c12fec38bb3867ae">XOcp_GenSharedSecretWithDevAk()</a>.</p>

</div>
</div>
<a class="anchor" id="ga41127f0b373baf2090c38aaecfe71f0b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOCP_API</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">ApiId</td><td>)</td>
          <td>&#160;&#160;&#160;((u32)ApiId)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Macro to typecast XOCP API ID. </p>

</div>
</div>
<a class="anchor" id="ga5b1f076af518588d82d3c1292274a1d9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOCP_API_ID_MASK&#160;&#160;&#160;0xFFU</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Mask for API ID in Secure IPI command. </p>

</div>
</div>
<a class="anchor" id="gaacfcb856e34e9be4766a8d0498ad832f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOcp_DCacheFlushRange</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">SrcAddr, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">Len&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;Xil_DCacheFlushRange((INTPTR)SrcAddr, Len)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Cache Invalidate function. </p>

</div>
</div>
<a class="anchor" id="gab835a3422a1a25e56cea83a48d48560e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOCP_DME_NONCE_SIZE_IN_BITS&#160;&#160;&#160;(256U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Nonce buffer size in bits. </p>

</div>
</div>
<a class="anchor" id="gaa8d58e56f5d115e19424d4d0d02b8207"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOCP_EXTENDED_HASH_SIZE_IN_BITS&#160;&#160;&#160;(384U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Extended hash buffer size in bits. </p>

</div>
</div>
<a class="anchor" id="ga7365d3fa2793edeb5a50ca16d130f019"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOCP_EXTENDED_HASH_SIZE_IN_BYTES&#160;&#160;&#160;(48U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Extended hash buffer size in bytes. </p>

<p>Referenced by <a class="el" href="group__xocp__client__apis.html#gab8fbe7fbfcb136e816374b295b769972">XOcp_ExtendSwPcr()</a>.</p>

</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="gae95d465df2996596afe4dd4e5f669667"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__xocp__api__ids.html#gae95d465df2996596afe4dd4e5f669667">XOcp_ApiId</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ggae95d465df2996596afe4dd4e5f669667a284a6e25cd4cd8ecd456b731f3ef8c94"></a>XOCP_API_FEATURES</em>&nbsp;</td><td class="fielddoc">
<p>0U </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ggae95d465df2996596afe4dd4e5f669667a0ea33ccca2247ae86b23182b1d691e25"></a>XOCP_API_EXTEND_HWPCR</em>&nbsp;</td><td class="fielddoc">
<p>1U </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ggae95d465df2996596afe4dd4e5f669667a0165a00496c3a9724f9e97be4262fef6"></a>XOCP_API_GET_HWPCR</em>&nbsp;</td><td class="fielddoc">
<p>2U </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ggae95d465df2996596afe4dd4e5f669667a04912d871713dcd3b61d694f429bc095"></a>XOCP_API_GET_HWPCRLOG</em>&nbsp;</td><td class="fielddoc">
<p>3U </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ggae95d465df2996596afe4dd4e5f669667ac30d0d7181e066b8a984ede325504cf8"></a>XOCP_API_GENDMERESP</em>&nbsp;</td><td class="fielddoc">
<p>4U </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ggae95d465df2996596afe4dd4e5f669667a7af3c34b216fdfca90d0d831514044a0"></a>XOCP_API_DEVAKINPUT</em>&nbsp;</td><td class="fielddoc">
<p>5U </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ggae95d465df2996596afe4dd4e5f669667a928aad79a711aa80ab131b85ca6951e5"></a>XOCP_API_GETCERTUSERCFG</em>&nbsp;</td><td class="fielddoc">
<p>6U </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ggae95d465df2996596afe4dd4e5f669667a27d6f0ea57a51b0b5cb4b61f85c690a8"></a>XOCP_API_GETX509CERT</em>&nbsp;</td><td class="fielddoc">
<p>7U </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ggae95d465df2996596afe4dd4e5f669667a82068a5409464a0f6dc3dcc23037d747"></a>XOCP_API_ATTESTWITHDEVAK</em>&nbsp;</td><td class="fielddoc">
<p>8U </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ggae95d465df2996596afe4dd4e5f669667a0849254c181626b2ccc0bca601313933"></a>XOCP_API_SET_SWPCRCONFIG</em>&nbsp;</td><td class="fielddoc">
<p>9U </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ggae95d465df2996596afe4dd4e5f669667a802d68e4fc35a8bb08e4e79fd2a5aa48"></a>XOCP_API_EXTEND_SWPCR</em>&nbsp;</td><td class="fielddoc">
<p>10U </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ggae95d465df2996596afe4dd4e5f669667a0d48b20c276c35c9e253b2756aa9f1ac"></a>XOCP_API_GET_SWPCR</em>&nbsp;</td><td class="fielddoc">
<p>11U </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ggae95d465df2996596afe4dd4e5f669667a4e737b47477267f9e7b792a237c388d0"></a>XOCP_API_GET_SWPCRLOG</em>&nbsp;</td><td class="fielddoc">
<p>12U </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ggae95d465df2996596afe4dd4e5f669667a6ad39f4af276b8893ca0e8975a6f8f6f"></a>XOCP_API_GET_SWPCRDATA</em>&nbsp;</td><td class="fielddoc">
<p>13U </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ggae95d465df2996596afe4dd4e5f669667a159154b25019671afd2acc943f5ee6e2"></a>XOCP_API_GEN_SHARED_SECRET</em>&nbsp;</td><td class="fielddoc">
<p>14U </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ggae95d465df2996596afe4dd4e5f669667a3ee212594f10d93c996947ac021ac2ef"></a>XOCP_API_ATTEST_WITH_KEYWRAP_DEVAK</em>&nbsp;</td><td class="fielddoc">
<p>15U </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ggae95d465df2996596afe4dd4e5f669667a3bc966370e0b71c627e2f312f0c3089e"></a>XOCP_API_MAX</em>&nbsp;</td><td class="fielddoc">
<p>16U </p>
</td></tr>
</table>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
